home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 034a / hsldr09b.zip / HSLDOOR.DOC < prev    next >
Text File  |  1991-12-01  |  8KB  |  203 lines
  1.                           ┌─────────────┐
  2.                           │ HSLDOOR.EXE │
  3.                           └─────────────┘
  4.                                  
  5.              HS/Link Bi-Directional File Transfer Door
  6.                             Tom Kellen
  7.                    ßETATech Computer Consulting
  8.                            Version 0.05ß
  9.  
  10. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  11.  
  12. PURPOSE:  To provide a means for Spitfire SysOps to implement
  13.           HS/Link's Bi-Directional file transfers. 
  14.  
  15.  
  16.  
  17. INTRODUCTION:
  18.  
  19. THIS RELEASE IS AN EXTREMELY ROUGH BETA VERSION.  MANY FEATURES ARE
  20. STILL TO COME.  THIS VERSION IS FUNCTIONAL, BUT USE IT AT YOUR OWN
  21. RISK AS THIS SOFTWARE HAS NOT BEEN THOROUGHLY TESTED.
  22.  
  23. I've just begun playing with Samuel Smith's HS/Link file transfer
  24. protocol.  So far it has yielded impressive results, but alas,
  25. Spitfire BBS does not yet implement support for Bi-Directional
  26. protocols.  HSLDoor should make full use of this protocol on a
  27. Spitfire BBS possible.
  28.  
  29.  
  30.  
  31. INSTALLATION:
  32.  
  33. HSLDoor assumes that you have read the documentation for HS/Link and
  34. have used HSCONFIG to configure your copy of HS/Link.  HSLDoor imposes
  35. very little control over HS/Link.  HSLDoor also assumes that HS/Link
  36. resides in a directory that is on your PATH (hmmm, that's a lot of
  37. assumptions).
  38.  
  39. Create a directory for HSLDoor.  For documentation purposes we will
  40. assume that you are using C:\SF\HSLDR.  Copy HSLDOOR.EXE and
  41. HSLDOOR.CFG into this directory.
  42.  
  43. You will need to modify at least 2 lines in HSLDOOR.CFG (any text
  44. after the ; are considered comments and ignored).  Here is an example
  45. configuration file:
  46.  
  47. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  48. BBS=The Paradigm BBS; BBS Name
  49. REGNO=62526; Registration Number
  50. DEST=D:\TC\LD\; Final destination for uploaded files
  51. LOG=E:\TP\BCC\SF\CALLERS.TMP;
  52. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  53.  
  54. The first line is the name of your BBS.  This will be displayed as the
  55. door closes and will also be displayed on all menus once you register
  56. the door.
  57.  
  58. The second line is your registration number.  If you are still
  59. evaluating the door and have not registered, leave this as 000000.
  60.  
  61. The final line is the destination path for all the files uploaded
  62. through HSLDoor.
  63.  
  64. The fourth is optional and is an alternate log file name if you don't 
  65. wish logging to CALLERS.TMP.
  66.  
  67. You must use the keywords BBS=, REGNO=, DEST=, and LOG=.
  68.  
  69. Once you have completed this, you will need to modify your SF.BAT to
  70. install this door.  This is pretty straight forward, and like any
  71. other Spitfire door.  Here is a snippet from my SF.BAT:
  72.  
  73. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  74. :DOOR_H
  75. REM HS/Link Transfer Door
  76. cd\sf\hsldr
  77. copy c:\sf\sfdoors.dat
  78. HSLDOOR
  79. erase sfdoors.dat
  80. CD \SF
  81. GOTO LOOP
  82. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  83.  
  84. This snippet is also included in the distribution ZIP as SF.BAT.  Just
  85. remember to copy SFDOORS.DAT (or one of the other SFxxxx.DAT files if
  86. running from a menu) to the HSLDoor's directory.  HSLDoor needs this
  87. information and will update the master copy in your node directory
  88. after it has run.
  89.  
  90. The final step is to edit your SFDOOR.MNU file and add a line for this
  91. door.  See your Spitfire manual if you need more information on this.
  92.  
  93. That should get you going.
  94.  
  95.  
  96.  
  97. OPERATION:
  98.  
  99. The first time HSLDoor is run it will create a directory under it's
  100. home directory called HSLTR.WRK.  HSLDoor uses this directory during
  101. file transfers.  DO NOT use this directory or copy any files to it as
  102. HSLDoor deletes all the contents when it is through working.
  103.  
  104. When a user runs HSLDoor, it reads the SFDOORS.DAT file to get all the
  105. vital information.  It then goes out and get's a list of all the
  106. directories that this user should have access to based on the
  107. information you have configured for your BBS (this is stored in
  108. SFFAREA.DAT).
  109.  
  110. From the door's main menu, the user has 4 choices.  [ D ] takes the
  111. user to a menu where they can request files for download.  This will
  112. create a listing of up to 100 files.  If the file is available to the
  113. user, it is added to their list and they are notified of the byte size
  114. of the file.
  115.  
  116. [ U ] takes the user to a menu where they can create a list of the
  117. files they will upload.  They are prompted for file name and a 45
  118. character file description.
  119.  
  120. Once either or both of the above options have been completed, the user
  121. should select [ S ] start their HS/Link transfer.  All of the files
  122. uploaded will go into the HSLTR.WRK directory.  Once the transfer is
  123. completed, HSLDoor will check the files uploaded with the list the
  124. user provided.  If they uploaded different files, the user will be
  125. asked to provide a description for those files.  Once the door has all
  126. the descriptions for all the files, they will be moved from the
  127. HSLTR.WRK directory to the destination directory you specified on the
  128. third line of the HSLDoor configuration file.  The SFFILES.BBS file
  129. in this directory will also be updated with the file name, size, date
  130. uploaded, and description.
  131.  
  132. The final [ Q ] option exits the user from the door.
  133.  
  134. HSLDoor will log it's transactions to your caller's log for
  135. informational purposes.  When the user exits the door, HSLDoor will
  136. update the master copy of SFDOORS.DAT so that the user is credited for
  137. their uploads and downloads.
  138.  
  139. That's about all there is to the door right now.  Quite simple and
  140. straight forward.
  141.  
  142.  
  143.  
  144. KNOWN LIMITATIONS and COMING ATTRACTIONS:
  145.  
  146. *    HSLDoor does not do very extensive checking for file space
  147.      before attempting to copy the files to the destination
  148.      directory.  This will come shortly.
  149.  
  150. *    Much better documentation.  This is a 2:00 am slap together.
  151.  
  152.  
  153. Any and all other suggestions you may have are welcomed and
  154. appreciated.  I would like to make this door as useful as possible.
  155.  
  156.  
  157. NOTE:     One final reminder, this software is VERY beta and has had
  158.           VERY LITTLE testing.  I am counting on you all for that. 
  159.           Use the door at your own risk, but please provide as much
  160.           feed back as possible!!
  161.  
  162.  
  163.  
  164. EPILOGUE:
  165.  
  166. This is a SHAREWARE utility.  The program is NOT crippled and NO
  167. features are disabled.  Sending in the $5.00 US registration fee with
  168. the registration form to the address below will get you a registration
  169. number that will remove the [Unregistered Shareware Version] message
  170. and allow your BBS name to be displayed.  
  171.  
  172. Try the door thoroughly until you know in your heart that it is of use
  173. to you, and then send in the registration form and fee.  If it isn't,
  174. please let me know what features might improve the door.
  175.  
  176. HS/Link is Copyright by Samuel H. Smith and you are highly encouraged
  177. to register this superb file transfer protocol.
  178.  
  179.  
  180. AUTHOR CONTACT:
  181.  
  182. Problems, solutions, kudos and ideas are welcomed.  I can be reached
  183. at the following:
  184.  
  185. The Paradigm BBS                   ßETATech Computer Consulting
  186. 404/671-1581                       P. O. Box 566742
  187. 1200-19,200 Baud 24 Hrs/Day        Atlanta, GA  30356-6013
  188. DISCLAIMER:
  189.  
  190. Use of this program acknowledges this disclaimer of warranty: "This
  191. program is supplied as is.  ßETATech Computer Consulting disclaims all
  192. warranties, express or implied, including, without limitation, the
  193. warranties of merchantability and of fitness of this program for any
  194. purpose.  ßETATech Computer Consulting assumes no liability for
  195. damages direct or consequential, which may result from the use of this
  196. program."
  197.  
  198.  
  199.  
  200. REVISION HISTORY:
  201.  
  202. 26-NOV-1991    v0.02ß         VERY ßeta Initial Release.
  203.